Text Block 3D displays a small amount of text in 3D. More...

#include <kanzi/ui/node/text_block3d.hpp>

Inheritance diagram for kanzi::TextBlock3D:

Public Types
typedef TextBlockConceptImpl< Node3D, TextBlock3D >	ConceptClass

Public Types inherited from kanzi::Node3D
typedef ChildContainer::const_iterator	ChildConstIterator

typedef ChildContainer::const_reverse_iterator	ChildConstReverseIterator

typedef vector< Node3DSharedPtr >	ChildContainer
	Iterators for child nodes.

typedef Matrix4x4	LayoutMatrixType

typedef Vector3	LayoutVectorType

using	RenderEntryParameterContainer
	The type to use to return render entries from nodes.

enum	RenderMode { RenderModeNone , RenderModeDefault , RenderModeCustom }
	Specifies the rendering modes available for a 3D node. More...

Public Types inherited from kanzi::Node
enum	ContentStretch { ContentStretchNone , ContentStretchFill , ContentStretchUniform , ContentStretchUniformToFill , ContentStretchRepeat }
	Content stretch option. More...

enum	DepthAlignment { DepthAlignmentBack , DepthAlignmentFront , DepthAlignmentCenter , DepthAlignmentStretch }
	Depth alignment options. More...

enum	HorizontalAlignment { HorizontalAlignmentLeft , HorizontalAlignmentRight , HorizontalAlignmentCenter , HorizontalAlignmentStretch }
	Horizontal alignment options. More...

typedef InputManipulatorContainer::const_iterator	InputManipulatorConstIterator

typedef vector< InputManipulatorBaseSharedPtr >	InputManipulatorContainer
	Gets the input manipulator iterator.

typedef InputManipulatorContainer::iterator	InputManipulatorIterator

typedef kanzi::vector< Node::MessageSubscriptionToken >	MessageSubscriptionTokenVector

typedef NodeComponentContainer::const_iterator	NodeComponentConstIterator

typedef vector< NodeComponentEntry >	NodeComponentContainer
	Gets the node component iterator.

typedef NodeComponentContainer::iterator	NodeComponentIterator

enum	VerticalAlignment { VerticalAlignmentBottom , VerticalAlignmentTop , VerticalAlignmentCenter , VerticalAlignmentStretch }
	Vertical alignment options. More...

typedef function< VisitorResult(Node &)	Visitor)
	Defines the type of the function that Kanzi executes for each node when visiting a node tree.

enum	VisitorOrder { VisitorPreOrder , VisitorPostOrder }
	Defines the order in which Kanzi visits the nodes in a node tree. More...

enum	VisitorResult { VisitorAbort , VisitorContinue , VisitorContinueSibling }
	Defines the return type of the Node::Visitor function. More...

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Types inherited from kanzi::BindingHostConcept
using	BindingHostConceptSharedPtr
	Binding host concept shared pointer type.

using	BindingRuntimeConstIterator
	Const iterator for binding runtimes.

using	BindingRuntimeContainer
	Container for binding runtimes.

using	BindingRuntimeIterator
	Iterator for binding runtimes.

Public Member Functions
TextureSharedPtr	getGlyphTexture () const
	Access glyph texture.

void	restoreResources () override
	Node::restoreResources() implementation.

	~TextBlock3D () override
	Destructor.

Public Member Functions inherited from kanzi::TextBlockConceptImpl< Node3D, TextBlock3D >
RectangleFloat	getTextBounds () const
	Get bounding rectangle for the text.

bool	getWordWrap () const
	Gets the value of WordWrapProperty.

void	notifyPostPrepareTextFormat (bool completeRelayoutingExecuted)
	Kanzi calls this function every time it successfully completes the TextConceptImpl::prepareTextFormat() function.

void	setWordWrap (bool value)
	Sets the value of WordWrapProperty.

Public Member Functions inherited from kanzi::Node3D
bool	addAbstractChildOverride (NodeSharedPtr child) override

void	addChild (const Node3DSharedPtr &child)
	Adds a child node to a 3D node.

void	arrange ()
	Performs layout arrangement on a 3D node.

void	arrangeIterate ()
	Initial scene arrange.

void	arrangeIterateLayout (bool propagateArrange)

void	arrangeIterateLayoutChild (bool propagateArrange)

ChildConstIterator	beginChildren () const

void	centeredArrange (Vector3 actualSize) const
	Default implementation of arrange for a layout that accommodates all children at its center.

Vector3	centeredMeasure (Vector3 availableSize) const
	Default implementation of measure for a layout that accommodates all children at its center.

ChildConstIterator	endChildren () const

const RenderEntryParameterContainer *	generateRenderStates (DrawObjectsRenderPass &drawPass)
	Gets a listing of render entry parameters to use to generate render states.

size_t	getAbstractChildCountOverride () override

size_t	getAbstractChildIndexOverride (const Node &node) override

NodeSharedPtr	getAbstractChildOverride (size_t index) override

Vector3	getActualSize () const
	Returns the actual size of a 3D node.

Vector3	getAllocatedOffset () const
	Returns the allocated offset of a 3D node.

Vector3	getAllocatedSize () const
	Returns the allocated size of a 3D node.

Matrix4x4	getArrangeTransformation () const
	Returns the layout transformation of a 3D node.

Node3DSharedPtr	getChild (size_t index) const
	Gets a child node at a given `index`.

size_t	getChildCount () const
	Gets the number of child nodes in a 3D node.

size_t	getChildIndex (const Node &child) const
	Gets the index of a `child` node.

Vector3	getCoreDesiredSize () const
	Returns the core desired size of a 3D node.

Vector3	getDesiredSize () const
	Returns the desired size of a 3D node.

Node3DSharedPtr	getFaceToCameraTarget () const

void	getLayoutBoundingBoxSize (Vector3 &bboxMin, Vector3 &bboxMax) const
	Returns the size of the bounding box of a 3D node.

Node3DSharedPtr	getLookAtTarget () const

Vector3	getMaximumBoundingBoxCoordinates () const
	Returns the maximum coordinates for the bounding volume of a 3D node.

Vector3	getMinimumBoundingBoxCoordinates () const
	Returns the minimum coordinates for the bounding volume of a 3D node.

Node3DSharedPtr	getOrientationConstraintTarget () const

Vector3	getPivotOffset () const
	Returns the pivot offset of a 3D node.

Node3DSharedPtr	getPositionConstraintTarget () const

RenderMode	getRenderMode () const
	Returns the render mode.

Vector3	getSize () const
	Returns the size of a 3D node.

Vector3	getStretchScale () const
	Returns the stretch scale of a 3D node.

bool	hasChild (const Node &child) const
	Returns whether a child node exists.

virtual pair< NodeSharedPtr, float >	hitTestContent (const Ray &ray)
	Default hit test implementation of Node3D content.

void	insertChild (size_t index, const Node3DSharedPtr &child)
	Adds to a 3D node a `child` node at a given `index`.

bool	isPrimitiveLayout () const
	Indicates whether a 3D node has primitive layout behavior.

void	layout ()
	Calculates the layouts in a scene recursively. Calls the measure and arrange functions of every 3D node in the scene.

void	measure (const Vector3 &availableSize)
	Performs the default measure step.

void	measureIterate ()
	Initial scene measure.

virtual bool	measureRecursive ()
	Performs layout measurement for a 3D node.

bool	moveAbstractChildToPositionOverride (NodeSharedPtr child, size_t index) override
	Node::moveAbstractChildToPosition() implementation.

void	moveChildToPosition (Node3DSharedPtr child, size_t index)
	Moves a child node to a given position in the list of child nodes.

void	moveToBack ()
	Repositions a 3D node to the beginning of the list of child nodes of its parent node, so that Kanzi draws the node first.

void	moveToFront ()
	Repositions a 3D node to the end of the list of child nodes of its parent node, so that Kanzi draws the node last.

virtual void	onTransform ()
	Per-node step performed on transform, after Kanzi calculates the final transformation.

ChildConstReverseIterator	rbeginChildren () const

void	registerDrawPass (DrawObjectsRenderPassSharedPtr drawPass)
	Registers a DrawObjectsRenderPass that renders a 3D node.

bool	removeAbstractChildOverride (Node &child) override

void	removeAllChildren ()
	Removes all child nodes from a 3D node.

void	removeChild (const Node &child)
	Removes a `child` node from a 3D node.

void	removeChild (size_t index)
	Removes from a 3D node a child node at a given `index`.

ChildConstReverseIterator	rendChildren () const

void	render (Renderer3D &renderer, RenderEntry3D &renderEntry)
	Renders a 3D node using a given render state.

void	setActualSize (const Vector3 &actualSize)
	Sets the actual size of a 3D node.

void	setAllocatedOffset (const Vector3 &allocatedOffset)
	Sets the allocated offset of a 3D node.

void	setAllocatedSize (const Vector3 &layoutSize)
	Sets the allocated size of a 3D node.

void	setArrangeTransformation (const Matrix4x4 &value)
	Sets the layout transformation of a 3D node.

void	setAutoDepth ()
	Sets a node to determine its depth automatically.

void	setAutoHeight ()
	Sets a node to determine its height automatically.

void	setAutoSize ()
	Sets a node to determine its width, height, and depth automatically.

void	setAutoWidth ()
	Sets a node to determine its width automatically.

void	setCoreDesiredSize (const Vector3 &coreDesiredSize)
	Sets the core desired size of a 3D node.

void	setDesiredSize (const Vector3 &desiredSize)
	Sets the desired size of a 3D node.

void	setLayoutBoundingBoxSize (const Vector3 &bboxMin, const Vector3 &bboxMax)
	Sets the size of the bounding box of a 3D node.

void	setPivotOffset (const Vector3 &pivotOffset)
	Sets the pivot offset of a 3D node.

void	setRenderMode (RenderMode mode)
	Sets the render mode.

void	setSize (float width, float height, float depth)
	Sets the dimensions of a node.

void	setSize (Vector3 size)
	Sets the dimensions of a node.

void	setStretchScale (const Vector3 &stretchScale)
	Sets the stretch scale of a 3D node.

	~Node3D () override

Matrix4x4	getFinalTransformation () const
	Gets the value of the FinalTransformationProperty.

void	setFinalTransformation (Matrix4x4 value)
	Sets the value of the FinalTransformationProperty.

float	getFrustumCullMargin () const
	Gets the value of the FrustumCullMarginProperty.

void	setFrustumCullMargin (float value)
	Sets the value of the FrustumCullMarginProperty.

SRTValue3D	getRenderTransformation () const
	Gets the value of the RenderTransformationProperty.

void	setRenderTransformation (SRTValue3D value)
	Sets the value of the RenderTransformationProperty.

SRTValue3D	getLayoutTransformation () const
	Gets the value of the LayoutTransformationProperty.

void	setLayoutTransformation (SRTValue3D value)
	Sets the value of the LayoutTransformationProperty.

Public Member Functions inherited from kanzi::Node
ResourceSharedPtr	acquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary.

template<typename T >
shared_ptr< T >	acquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type.

ResourceManager::AcquireTaskSharedPtr	acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
	Posts an asynchronous task to acquire a resource.

ResourceDictionarySharedPtr	acquireResourceDictionary ()
	Gets a resource dictionary of a node.

void	addAnonymousResource (ResourceSharedPtr resource)
	Adds alias resource to an object node.

void	addInputManipulator (InputManipulatorBaseSharedPtr inputManipulator)
	Transfers the ownership and attaches an input manipulator to an object node.

template<typename TMessageType >
MessageSubscriptionToken	addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
	Adds a message filter where the filter is a function.

template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken	addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
	Adds a message filter where the filter is a method that is invoked on an object.

template<typename TMessageType >
MessageSubscriptionToken	addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function)
	Adds a message handler where the handler is a function.

template<typename TMessageType >
MessageSubscriptionToken	addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
	Adds a message handler where the handler is a function and you explicitly define the accepted source.

template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken	addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
	Adds a message handler where the handler is a method that is invoked on an object.

void	addNodeComponent (NodeComponentSharedPtr nodeComponent)
	Transfers the ownership of a node component to an object node.

void	addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner)
	Transfers the ownership of a node component to an object node and sets the owner of the node component.

void	addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference)

void	addResource (const ResourceID &resourceId, string_view resourceUrl)
	Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. *‍/.

void	addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
	Adds a nested resource dictionary to the resource dictionary of a node.

void	addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference)
	This is a helper for automatic resource tracking in ResourceReference.

template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken	addTunnelingFilter (const TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
	Adds a message filter where the filter is a method that is invoked on an object.

template<typename TMessageType >
MessageSubscriptionToken	addTunnelingFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
	Adds a message filter where the filter is a function.

template<typename TMessageType >
MessageSubscriptionToken	addTunnelingHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
	Adds a message handler where the handler is a function and you explicitly define the accepted source.

AppliedStyleEntrySharedPtr	applyManualStyle (StyleSharedPtr style)
	Applies a style to an object node.

AppliedStyleEntrySharedPtr	applyStyle (StyleSharedPtr style)
	Applies a style to an object node.

void	applyStyles ()
	Apply all styles for an object node.

void	applyStylesRecursive ()
	Applies styles recursively.

void	attachRecursive ()
	Attaches an object node and its children recursively.

InputManipulatorConstIterator	beginInputManipulators () const

NodeComponentConstIterator	beginNodeComponents () const

void	clearChangeFlag (uint32_t flag)
	Clears a change flag.

void	clearChildChangeFlag (uint32_t flag)
	Clears a child change flag.

bool	containsResource (const ResourceID &resourceID) const
	Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. *‍/.

BindingLookupContextPtr	createLookupContext (NodeSharedPtr templateRoot)
	Creates a lookup context for the node.

void	detachRecursive ()
	Detaches a node and its descendants.

void	dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments)
	Dispatches a message from this node with specified arguments.

template<typename TArgumentsType >
void	dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
	Dispatches a message from this node with specified arguments.

InputManipulatorConstIterator	endInputManipulators () const

NodeComponentConstIterator	endNodeComponents () const

template<typename TNodeType >
shared_ptr< TNodeType >	findAbstractChild (string_view name)
	Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene.

optional< string >	findResourceURL (const ResourceID &resourceId) const
	Tries to find Resource URL for Resource ID from this node.

template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

uint32_t	getChangeFlags () const
	Get current change flags.

uint32_t	getChildChangeFlags () const
	Get current child change flags.

FocusManager *	getFocusManager () const
	Returns the Focus Manager associated with the Screen node to which this node belongs.

FocusScope *	getFocusScopeInfo () const
	Returns the information about the focus scope for a node.

InputManager *	getInputManager () const
	Returns the Input Manager associated with the Screen node to which this node belongs.

AbstractPropertyTypeDescriptor::ValueSource *	getNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

template<typename DataType >
optional< typename PropertyType< DataType >::DataType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.

Node *	getParent () const
	Returns the parent of the node.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property.

ResourceDictionarySharedPtr	getResourceDictionary () const
	If a node has a resource dictionary, returns the resource dictionary of that node.

Screen *	getScreen () const
	Returns the Screen node to which this node belongs.

NodeSharedPtr	getTemplateRoot () const
	Gets the template root of this node.

void	invalidateArrange ()
	Invalidates arrange.

void	invalidateDraw ()
	Invalidates draw flag for the node.

void	invalidateFinalTransform ()
	Invalidates final transform for node.

void	invalidateMeasure ()
	Invalidates measure for the node.

void	invalidateRender ()
	Invalidates render for node.

bool	isAnyChangeFlagSet (uint32_t flag) const
	Checks if any of given flags is set.

bool	isAnyChildChangeFlagSet (uint32_t flag) const
	Checks if any child change flags (corresponding to given mask) are set.

bool	isAttached () const
	Returns true if the node is attached to a screen or one of its descendants.

bool	isAttaching () const
	Returns true if node is in the process of attaching, false otherwise.

bool	isChangeFlagSet (uint32_t flag) const
	Checks if a change flag is set.

bool	isChildChangeFlagSet (uint32_t flag) const
	Checks if child change flags match.

bool	isDetaching () const
	Returns true if the node currently detaching.

bool	isEffectivelyFocusable () const
	Returns whether a node is focusable.

bool	isEffectivelyVisible () const
	Returns whether a node and its ancestor nodes are visible.

bool	isInitialized () const
	Returns true if initialize() has been called, false otherwise.

bool	isInvalidArrange () const
	Checks if the node needs arrange.

bool	isInvalidDraw ()
	Tells if node draw flag is invalid.

bool	isInvalidFinalTransform () const
	Tells if final transform flag is invalid for node.

bool	isInvalidMeasure () const
	Check if the node needs measure.

bool	isInvalidRender () const
	Returns if node render flag is invalid.

bool	isNamed (string_view name) const

	KZ_METACLASS_PROPERTY_TYPE (FontFamilyProperty)

template<typename Type >
shared_ptr< Type >	lookupNode (string_view pathOrKey)
	Returns a node of specified type by looking it up with specified path or alias.

template<typename Type >
shared_ptr< Type >	lookupNodeComponent (string_view name)
	Returns a node component of specified type by looking it up with specified name.

Node *	lookupNodeRaw (string_view relativePath)
	Get an object node by another node and a relative path.

ObjectSharedPtr	lookupObject (string_view relativePath)
	Lookup for an object from a node.

template<typename Type >
shared_ptr< Type >	lookupObject (string_view relativePath)
	Lookup for an object from a node.

tuple< NodeSharedPtr, AbstractPropertyType >	lookupObjectForStateManager (string_view relativePath)
	Lookup for an node and possible object from within the node for state manager.

void	notifyResourceDictionaryModified ()
	Forces the re-evaluation of resource IDs in a node tree.

void	removeAnonymousResource (const Resource &resource)
	Removes anonymous resource from object node resources.

void	removeInputManipulator (InputManipulator &inputManipulator)
	Removes the ownership and detaches an input manipulator from an object node.

void	removeKZBData ()
	Destroys all object node data loaded from KZB.

void	removeKZBData (flat_set< AbstractPropertyType > *keepProperties)
	Destroys all object node data loaded from KZB, including properties, bindings, node components, resources etc.

void	removeMessageHandler (MessageSubscriptionToken token)
	Removes a message subscription.

void	removeNodeComponent (NodeComponent &nodeComponent)
	Removes the ownership of a node component from an object node.

void	removeNodeComponentWithOwner (const void *owner)
	Removes all bindings with the specified owner.

void	removeNodeReference (const AbstractNodeReference &reference)

void	removeResource (const ResourceID &resourceId)
	Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. *‍/.

void	removeResourceReference (const AbstractResourceReference &reference)
	This is a helper for automatic resource tracking in ResourceReference.

void	setChangeFlag (uint32_t flag)
	Sets a change flag.

void	setChildChangeFlag (uint32_t flag)
	Sets a child change flag.

void	setParent (Node *parent)
	Kanzi uses this method internally to set the parent of a node.

void	setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
	Replaces the resource dictionary of a node.

void	setScreen (Screen *screen)
	Sets the Screen node to which this node belongs.

void	setTemplateRoot (NodeSharedPtr templateRoot)
	Sets the template root of this node.

ResourceSharedPtr	tryAcquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary.

template<typename T >
shared_ptr< T >	tryAcquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type.

KZ_DEPRECATED NodeSharedPtr	trySetActiveFocus ()
	Tries to move the focus on this node.

NodeSharedPtr	trySetFocus ()
	Tries to move the focus to this node.

NodeSharedPtr	trySetFocus (FocusFallback fallbackOption)
	Tries to set the focus to the newFocusNode using FocusManager::trySetFocus() but with a fallback behavior in case the node does not gain focus.

void	unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
	Unapplies a style from an object node.

void	unapplyStyles ()
	Unapplies and removes all applied styles.

void	unapplyStylesRecursive ()
	Unapplies styles recursively.

void	validateArrange ()
	Validates arrange.

void	validateDraw ()
	Validates draw flags for the node.

void	validateDrawForChildrenRecursive ()
	Recursively validates draw for the children from this 2D node onwards.

void	validateMeasure ()
	Validates measure for the node.

void	validateRender ()
	Validates render for node.

VisitorResult	visit (const Visitor &visitor, VisitorOrder order)
	Visits a node and its descendants.

VisitorResult	visitDescendants (const Visitor &visitor, VisitorOrder order)
	Visits the descendants of a node.

	~Node () override
	Destructor.

string	getName () const
	Gets the value of NameProperty.

void	setName (string_view value)
	Sets the value of NameProperty.

string	getPath () const
	Gets the value of PathProperty.

void	setPath (string value)
	Sets the value of PathProperty.

string	getLocale () const
	Gets the value of LocaleProperty.

void	setLocale (string value)
	Sets the value of LocaleProperty.

bool	isHitTestable () const
	Gets the value of HitTestableProperty.

void	setHitTestable (bool value)
	Sets the value of HitTestableProperty.

bool	isHitTestableContainer () const
	Gets the value of HitTestableContainerProperty.

void	setHitTestableContainer (bool value)
	Sets the value of HitTestableContainerProperty.

bool	isVisible () const
	Gets the value of VisibleProperty.

void	setVisible (bool value)
	Sets the value of VisibleProperty.

bool	isEnabled () const
	Returns the value of the EnabledProperty.

void	setEnabled (bool value)
	Sets the value of the EnabledProperty.

bool	isEffectivelyEnabled () const
	Returns the value of EffectivelyEnabledProperty.

bool	isFocusable () const
	Gets the value of the FocusableProperty.

void	setFocusable (bool value)
	Sets the value of the FocusableProperty.

bool	isFocused () const
	Gets the value of the FocusedProperty.

void	setFocused (bool value)
	Sets the value of the FocusedProperty.

FocusState	getFocusState () const
	Gets the value of the FocusStateProperty.

void	setFocusState (FocusState state)
	Sets the value of the FocusStateProperty.

FontFamilySharedPtr	getFontFamily () const
	Gets the font family the node uses.

void	setFontFamily (FontFamilySharedPtr value)
	Sets the font family the node uses.

float	getVisibleAmountInParent () const
	Gets the value of VisibleAmountInParentProperty.

void	setVisibleAmountInParent (float value)
	Sets the value of VisibleAmountInParentProperty.

float	getProjection2DTo3DScale () const
	Gets the value of Projection2DTo3DScaleProperty.

void	setProjection2DTo3DScale (float value)
	Sets the value of Projection2DTo3DScaleProperty.

ResourceSharedPtr	getStyle () const
	Gets the value of StyleProperty.

void	setStyle (ResourceSharedPtr value)
	Sets the value of StyleProperty.

ResourceSharedPtr	getStateManager () const
	Gets the value of StateManagerProperty.

void	setStateManager (ResourceSharedPtr value)
	Sets the value of StateManagerProperty.

float	getWidth () const
	Gets the value of WidthProperty.

void	setWidth (float value)
	Sets the value of WidthProperty.

float	getHeight () const
	Gets the value of HeightProperty.

void	setHeight (float value)
	Sets the value of HeightProperty.

float	getDepth () const
	Gets the value of DepthProperty.

void	setDepth (float value)
	Sets the value of DepthProperty.

float	getActualWidth () const
	Gets the value of ActualWidthProperty.

void	setActualWidth (float value)
	Sets the value of ActualWidthProperty.

float	getActualHeight () const
	Gets the value of ActualHeightProperty.

void	setActualHeight (float value)
	Sets the value of ActualHeightProperty.

float	getActualDepth () const
	Gets the value of ActualDepthProperty.

void	setActualDepth (float value)
	Sets the value of ActualDepthProperty.

Node::HorizontalAlignment	getHorizontalAlignment () const
	Gets the value of HorizontalAlignmentProperty.

void	setHorizontalAlignment (Node::HorizontalAlignment value)
	Sets the value of HorizontalAlignmentProperty.

Node::VerticalAlignment	getVerticalAlignment () const
	Gets the value of VerticalAlignmentProperty.

void	setVerticalAlignment (Node::VerticalAlignment value)
	Sets the value of VerticalAlignmentProperty.

Node::DepthAlignment	getDepthAlignment () const
	Gets the value of DepthAlignmentProperty.

void	setDepthAlignment (Node::DepthAlignment value)
	Sets the value of DepthAlignmentProperty.

Vector2	getHorizontalMargin () const
	Gets the value of HorizontalMarginProperty.

void	setHorizontalMargin (Vector2 value)
	Sets the value of HorizontalMarginProperty.

Vector2	getVerticalMargin () const
	Gets the value of VerticalMarginProperty.

void	setVerticalMargin (Vector2 value)
	Sets the value of VerticalMarginProperty.

Vector2	getDepthMargin () const
	Gets the value of DepthMarginProperty.

void	setDepthMargin (Vector2 value)
	Sets the value of DepthMarginProperty.

Node::ContentStretch	getContentStretch () const
	Gets the value of ContentStretchProperty.

void	setContentStretch (Node::ContentStretch value)
	Sets the value of ContentStretchProperty.

float	getOpacity () const
	Gets the value of OpacityProperty.

void	setOpacity (float value)
	Sets the value of OpacityProperty.

bool	isHover () const
	Returns whether the node has HoverProperty set to true.

bool	isClipChildren () const
	Gets the value of ClipChildrenProperty.

void	setClipChildren (bool value)
	Sets the value of ClipChildrenProperty.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Public Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
void	addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner)
	Adds an already-created binding runtime to this binding host.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding)
	Wrapper for setting a binding with no target.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot)
	Sets a binding with no target.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
	Wrapper for setting a binding with no target.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
	Wrapper for setting a binding with owner.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding with owner.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot)
	Sets a binding with no target.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Sets a binding to a certain property.

BindingRuntimeHandle	setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Sets a modifier binding.

Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator	beginBindingRuntimes () const
	Returns an iterator to the beginning of binding runtimes.

BindingRuntimeConstIterator	endBindingRuntimes () const
	Returns an iterator to the end of binding runtimes.

AbstractBindingRuntimeSharedPtr	getBindingRuntime (size_t idx)
	Gets binding by index.

size_t	getBindingRuntimeCount () const
	Gets the number of binding runtimes added to this node.

void	removeAllBindings ()
	Removes all binding runtimes.

void	removeBinding (BindingRuntimeHandle &bindingRuntime)
	Removes a binding runtime added earlier.

void	removeBindingsWithOwner (shared_ptr< void > owner)
	Removes all binding runtimes with the specified owner.

Public Member Functions inherited from kanzi::FontStyleConceptImpl< TDerivedClass >
float	getCharacterSpacing () const
	Gets the value of the FontStyleConcept::CharacterSpacingProperty property.

float	getFixedCharacterWidth () const
	Gets the value of the FontStyleConcept::FixedCharacterWidthProperty property.

float	getFontSize () const
	Gets the value of the FontStyleConcept::SizeProperty property.

FontStyle	getFontStyle () const
	Gets the value of the FontStyleConcept::StyleProperty property.

FontWeight	getFontWeight () const
	Gets the value of the FontStyleConcept::WeightProperty property.

bool	getFractionalCharacterWidth () const
	Gets the value of the FontStyleConcept::FractionalCharacterWidthProperty property.

FontHintingPreference	getHintingPreference () const
	Gets the value of HintingPreferenceProperty.

float	getLineSpacing () const
	Gets the value of the FontStyleConcept::LineSpacingProperty property.

FontRuntimeSharedPtr	getRuntimeFont ()
	Gets the runtime font.

bool	getSnapCharacterToPixel () const
	Gets the value of the FontStyleConcept::SnapCharacterToPixelProperty property.

void	releaseRuntimeFont ()
	Releases the runtime font that is held by FontStyleConceptImpl.

void	setCharacterSpacing (float value)
	Sets the value of the FontStyleConcept::CharacterSpacingProperty property.

void	setFixedCharacterWidth (float value)
	Sets the value of the FontStyleConcept::FixedCharacterWidthProperty property.

void	setFontSize (float value)
	Sets the value of the FontStyleConcept::SizeProperty property.

void	setFontStyle (FontStyle style)
	Sets the value of the FontStyleConcept::StyleProperty property.

void	setFontWeight (FontWeight weight)
	Sets the value of the FontStyleConcept::WeightProperty property.

void	setFractionalCharacterWidth (bool enable)
	Sets the value of the FontStyleConcept::FractionalCharacterWidthProperty property.

void	setHintingPreference (FontHintingPreference hintingPreference)
	Sets the value of HintingPreferenceProperty.

void	setLineSpacing (float value)
	Sets the value of the FontStyleConcept::LineSpacingProperty property.

void	setSnapCharacterToPixel (bool enable)
	Sets the value of the FontStyleConcept::SnapCharacterToPixelProperty property.

bool	updateRuntimeFont ()
	Updates the runtime font.

Public Member Functions inherited from kanzi::TextConceptImpl< TDerivedClass >
ColorRGBA	getFontColor () const
	Gets the value of the FontColorProperty.

MaterialSharedPtr	getFontMaterial () const
	Gets the value of the FontMaterialProperty.

bool	getHorizontalFit () const
	Gets the value of the HorizontalFitProperty.

Vector2	getHorizontalFitScaleLimits () const
	Gets the value of the HorizontalFitScaleLimitsProperty.

Vector2	getHorizontalPadding () const
	Gets the value of HorizontalPaddingProperty.

string	getOverflow () const
	Gets the value of the OverflowProperty.

bool	getRemoveSideBearings () const
	Gets the value of the RemoveSideBearingsProperty.

string	getText () const
	Gets the value of TextProperty.

TextFormat::TextHorizontalAlignment	getTextHorizontalAlignment () const
	Gets the value of the TextHorizontalAlignmentProperty.

TextFormat::TextVerticalAlignment	getTextVerticalAlignment () const
	Gets the value of the TextVerticalAlignmentProperty.

TextFormat::Truncation	getTruncation () const
	Gets the value of the TruncationProperty.

TextFormat::TruncationDirection	getTruncationDirection () const
	Gets the value of the TruncationDirectionProperty.

Vector2	getVerticalPadding () const
	Gets the value of VerticalPaddingProperty.

void	setFontColor (ColorRGBA value)
	Sets the value of the FontColorProperty.

void	setFontMaterial (MaterialSharedPtr value)
	Sets the value of the FontMaterialProperty.

void	setHorizontalFit (bool value)
	Sets the value of the HorizontalFitProperty.

void	setHorizontalFitScaleLimits (Vector2 value)
	Sets the value of the HorizontalFitScaleLimitsProperty.

void	setHorizontalPadding (Vector2 value)
	Sets the value of HorizontalPaddingProperty.

void	setOverflow (string_view value)
	Sets the value of the OverflowProperty.

void	setRemoveSideBearings (bool value)
	Sets the value of the RemoveSideBearingsProperty.

void	setText (string value)
	Sets the value of TextProperty.

void	setTextHorizontalAlignment (TextFormat::TextHorizontalAlignment value)
	Sets the value of the TextHorizontalAlignmentProperty.

void	setTextVerticalAlignment (TextFormat::TextVerticalAlignment value)
	Sets the value of the TextVerticalAlignmentProperty.

void	setTruncation (TextFormat::Truncation value)
	Sets the value of the TruncationProperty.

void	setTruncationDirection (TextFormat::TruncationDirection value)
	Sets the value of the TruncationDirectionProperty.

void	setVerticalPadding (Vector2 value)
	Sets the value of VerticalPaddingProperty.

virtual	~TextConceptImpl ()=default
	Destructor.

Public Member Functions inherited from kanzi::TextConcept
virtual	~TextConcept ()=default
	Destructor.

Public Member Functions inherited from kanzi::RenderEntryRegistry< TextBlock3D >
void	cleanRenderEntryRegistry ()
	Clean references to this node from each DrawObjectsRenderPass that refers to this node.

TextBlock3D *	getThisObject ()
	Gets the pointer to this object.

void	insertReferringDrawPass (DrawObjectsRenderPassWeakPtr drawPass)
	Insert a referring draw pass.

	~RenderEntryRegistry ()
	Destructor.

Static Public Member Functions
static TextBlock3DSharedPtr	create (Domain *domain, string_view name)
	Creates a TextBlock3D node.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::TextBlockConceptImpl< Node3D, TextBlock3D >
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::Node3D
static bool	isUnboundedLayoutSize (Vector3 layoutSize)
	Returns whether a layout size is an unbounded layout size.

static bool	isValidLayoutSize (Vector3 size)
	Returns whether a given size is a valid layout size.

static float	layoutUp ()
	Returns the direction toward which the y axis of a 3D node grows.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static Vector3	replaceUnboundedLayoutSize (Vector3 layoutSize, Vector3 resetSize)
	Replaces any elements in an unbounded layout size with the corresponding elements of a given size.

static Vector3	replaceUnboundedLayoutSizeWithZero (Vector3 layoutSize)
	Replaces any elements in an unbounded layout size with zero.

static Vector3	unboundedLayoutSize ()
	Returns an unbounded layout size.

Static Public Member Functions inherited from kanzi::Node
static bool	isUnboundedLayoutValue (float layoutValue)
	Indicates whether a value is an unbound layout value.

static bool	isValidLayoutValue (float value)
	Indicates whether a value is valid layout value.

static float	replaceUnboundedLayoutValue (float layoutValue, float resetValue)
	Replaces layout value with the specified value if it is unbounded and returns it.

static float	replaceUnboundedLayoutValueWithZero (float layoutValue)
	Replaces layout value with zero if it is unbounded layout value and returns it.

static float	unboundedLayoutValue ()
	Returns an unbounded layout value.

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::TextBlockConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::FontStyleConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::TextConceptImpl< TDerivedClass >
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::TextConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
static const float	DefaultTextLayoutDepth
	The size of the text block in Z-direction.

Static Public Attributes inherited from kanzi::Node3D
static PropertyType< Matrix4x4 >	FinalTransformationProperty
	Sets the final transformation of a 3D node.

static PropertyType< float >	FrustumCullMarginProperty
	Sets the margin of the frustum cull radius of a 3D node.

static PropertyType< SRTValue3D >	RenderTransformationProperty
	Sets the render transformation of a 3D node.

static PropertyType< SRTValue3D >	LayoutTransformationProperty
	Sets the transformation of a 3D node relative to its parent node.

Static Public Attributes inherited from kanzi::Node
static PropertyType< string >	NameProperty
	Name property.

static PropertyType< string >	PathProperty
	Path property.

static PropertyType< string >	LocaleProperty
	Locale property.

static PropertyType< bool >	CreatedFromKZBProperty
	CreatedFromKZB property.

static PropertyType< bool >	HitTestableProperty
	HitTestable property.

static PropertyType< bool >	HitTestableContainerProperty
	HitTestableContainer property.

static PropertyType< bool >	VisibleProperty
	Visible property.

static PropertyType< bool >	EnabledProperty
	Sets whether the node is enabled.

static PropertyType< bool >	EffectivelyEnabledProperty
	Indicates whether the node and its ancestor nodes are enabled.

static PropertyType< bool >	FocusableProperty
	Sets whether a node can get focus and can participate in the focus chain navigation.

static PropertyType< bool >	FocusedProperty
	Sets whether a node is an focus node and can receive key messages.

static PropertyType< FocusState >	FocusStateProperty
	Reports the focus state of a focusable node or focus scope node.

static PropertyType< ResourceSharedPtr >	FontFamilyProperty
	Sets the font family the node uses.

static PropertyType< float >	VisibleAmountInParentProperty
	VisibleAmountInParent property.

static PropertyType< float >	Projection2DTo3DScaleProperty
	Projection2DTo3DScale property.

static PropertyType< ResourceSharedPtr >	StyleProperty
	Style property.

static PropertyType< ResourceSharedPtr >	StateManagerProperty
	StateManager property.

static PropertyType< void * >	PrefabTemplateSourceProperty
	PrefabTemplateSource property.

static PropertyType< float >	WidthProperty
	Width property.

static PropertyType< float >	HeightProperty
	Height property.

static PropertyType< float >	DepthProperty
	Depth property.

static PropertyType< float >	ActualWidthProperty
	ActualWidth property.

static PropertyType< float >	ActualHeightProperty
	ActualHeight property.

static PropertyType< float >	ActualDepthProperty
	ActualDepth property.

static PropertyType< Node::HorizontalAlignment >	HorizontalAlignmentProperty
	HorizontalAlignment property.

static PropertyType< Node::VerticalAlignment >	VerticalAlignmentProperty
	VerticalAlignment property.

static PropertyType< Node::DepthAlignment >	DepthAlignmentProperty
	DepthAlignment property.

static PropertyType< Vector2 >	HorizontalMarginProperty
	Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout.

static PropertyType< Vector2 >	VerticalMarginProperty
	Sets the vertical space between this node and other nodes that are adjacent to this node in a layout.

static PropertyType< Vector2 >	DepthMarginProperty
	Sets the space in the depth direction between this node and other nodes that are adjacent to this node in a layout.

static PropertyType< Node::ContentStretch >	ContentStretchProperty
	ContentStretch property.

static PropertyType< float >	OpacityProperty
	Opacity property.

static PropertyType< bool >	HoverProperty
	Kanzi updates the HoverProperty for a hit testable node to indicate whether the node is the foremost node under the cursor.

static PropertyType< bool >	ClipChildrenProperty
	ClipChildren property.

static PropertyType< int >	SceneGraphAddNodeChangeChildFlagsProperty
	SceneGraphAddNodeChangeChildFlags property.

static PropertyType< int >	SceneGraphAddNodeChangeParentFlagsProperty
	SceneGraphAddNodeChangeParentFlags property.

static PropertyType< int >	SceneGraphRemoveNodeChangeChildFlagsProperty
	SceneGraphRemoveNodeChangeChildFlags property.

static PropertyType< int >	SceneGraphRemoveNodeChangeParentFlagsProperty
	SceneGraphRemoveNodeChangeParentFlags property.

Static Public Attributes inherited from kanzi::TextBlockConcept
static PropertyType< bool >	WordWrapProperty
	Breaks long text lines to multiple lines to make the text fit within the boundaries of a Text Block node.

Static Public Attributes inherited from kanzi::FontStyleConcept
static PropertyType< float >	SizeProperty
	Sets the size for the font in pixels.

static PropertyType< FontStyle >	StyleProperty
	Sets the style for the font.

static PropertyType< FontWeight >	WeightProperty
	Sets the weight for the font.

static PropertyType< float >	CharacterSpacingProperty
	Sets the character spacing in pixels.

static PropertyType< float >	FixedCharacterWidthProperty
	Overrides the font advance widths and makes each character take a fixed amount of space specified in pixels.

static PropertyType< float >	LineSpacingProperty
	Sets the line spacing in multiples of the normal line height of the selected font.

static PropertyType< bool >	FractionalCharacterWidthProperty
	Sets whether Kanzi uses fractional or rounded character widths to lay out text.

static PropertyType< bool >	SnapCharacterToPixelProperty
	Sets whether Kanzi positions characters in 2D rendering to the nearest pixel:

static PropertyType< FontHintingPreference >	HintingPreferenceProperty
	Sets the hinting preference of the selected font.

Static Public Attributes inherited from kanzi::TextConcept
static PropertyType< ColorRGBA >	FontColorProperty
	Sets the text color for the default font material and for the materials with a fragment shader that uses the FontColor uniform.

static PropertyType< ResourceSharedPtr >	FontMaterialProperty
	Sets the material whose shader is used to render the text in a 3D text node.

static PropertyType< string >	TextProperty
	Sets the text content that a text node renders.

static PropertyType< TextFormat::TextHorizontalAlignment >	TextHorizontalAlignmentProperty
	Sets the horizontal alignment of the text in a text node.

static PropertyType< TextFormat::TextVerticalAlignment >	TextVerticalAlignmentProperty
	Sets the vertical alignment of the text in a text node.

static PropertyType< Vector2 >	HorizontalPaddingProperty
	Sets the padding spaces between the content and the left and right boundaries of a text node.

static PropertyType< Vector2 >	VerticalPaddingProperty
	Sets the padding spaces between the content and the top and bottom boundaries of a text node.

static PropertyType< string >	OverflowProperty
	Sets the characters that represent the truncated text when the text string to be rendered is too long to fit in a text node.

static PropertyType< TextFormat::Truncation >	TruncationProperty
	Sets how to truncate the text when the text string to be rendered is too long to fit in a node.

static PropertyType< TextFormat::TruncationDirection >	TruncationDirectionProperty
	Sets which part of the text to truncate when the text string to be rendered is too long to fit in a node.

static PropertyType< bool >	RemoveSideBearingsProperty
	Sets the position of the leftmost characters of left-aligned text and rightmost characters of right-aligned text exactly within the boundary of the text node.

static PropertyType< bool >	HorizontalFitProperty
	Allows a Text Block to scale glyphs horizontally when the text string is too long to fit in that Text Block.

static PropertyType< Vector2 >	HorizontalFitScaleLimitsProperty
	Sets the scale range that the HorizontalFitProperty can use when it scales the text horizontally.

Protected Member Functions
void	arrangeOverride (Vector3 actualSize) override
	Node3D::arrangeOverride() implementation.

const RenderEntryParameterContainer *	generateRenderStatesOverride (DrawObjectsRenderPass &drawPass) override
	Node3D::generateRenderStatesOverride() implementation.

optional< Box >	getBoundingBox () const override
	Node3D::getBoundingBox() implementation.

void	initialize ()
	Do TextBlock3D-specific initialization.

Vector3	measureOverride (Vector3 availableSize) override
	Node3D::measureOverride() implementation.

void	onDetached () override
	Node3D::onDetached() implementation.

void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Node::onNodePropertyChanged() implementation.

bool	prepareTextFormatForRendering ()
	Prepare text format for rendering.

void	registerDrawPassOverride (DrawObjectsRenderPassSharedPtr drawPass) override
	Node3D::registerDrawPassOverride() implementation.

void	renderOverride (Renderer3D &renderer, RenderEntry3D &renderState) override
	Node3D::renderOverride() implementation.

	TextBlock3D (Domain *domain, string_view name)
	Constructor.

void	updateRenderEntryParameters ()
	Update the internal storage of render entry parameters.

Protected Member Functions inherited from kanzi::TextBlockConceptImpl< Node3D, TextBlock3D >
TextConcept::TextFormatParameters	createTextFormatParameters (float width, float height) const
	Creates the parameters that are needed for initializing the TextFormat of a TextBlock node.

void	initialize ()
	TextBlockConceptImpl -specific initialization.

void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Node::onPropertyChanged implementation.

virtual void	onPostPrepareTextFormat (bool completeRelayoutingExecuted)
	Kanzi calls this function every time it completes the prepareTextFormat function.

	TextBlockConceptImpl (Domain *domain, string_view name)
	Constructor.

Protected Member Functions inherited from kanzi::Node3D
NodeSharedPtr	findAbstractChildOverride (string_view name) override

void	initialize ()

	Node3D (Domain *domain, string_view name)

void	onAttached () override
	Node::onAttached() implementation.

void	setPrimitiveLayout (bool primitive)
	Sets primitive layout flag.

VisitorResult	visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) override

Protected Member Functions inherited from kanzi::Node
void	attach ()
	Attaches the object node.

void	detach ()
	Detaches the object node.

void	initialize ()
	Node-specific initialization.

	Node (Domain *domain, string_view name)
	Constructor.

void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason) override
	Notifies all property handlers on a property storage.

virtual void	updateFocusScopeInfo (FocusScopePtr &nodeScopeInfo)
	Updates the overlay scope information that is attached to the root node of an overlay scope.

void	updatePropertiesForConnectedNode ()
	Invokes property notifications for inherited properties during node tree connections.

void	updatePropertiesForDisconnectedNode (Node *oldParent)
	Invokes property notifications for inherited properties during node tree disconnections.

void	updateResourceReferences ()

void	updateResourceReferences (AbstractPropertyType propertyType)

void	updateResourceReferencesRecursive ()

void	updateResourceReferencesRecursive (const ResourceID &resourceID)

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Protected Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
Node *	getThisObject ()
	Internal accessor for the Curiously Recurring Template Pattern.

const Node *	getThisObject () const
	Internal accessor for the Curiously Recurring Template Pattern.

Protected Member Functions inherited from kanzi::BindingHostConcept
void	attachBindings ()
	Attach all bindings stored in this object.

void	detachBindings ()
	Detach bindings.

Protected Member Functions inherited from kanzi::FontStyleConceptImpl< TDerivedClass >
	FontStyleConceptImpl ()=default
	Constructor.

Protected Member Functions inherited from kanzi::TextConceptImpl< TDerivedClass >
void	prepareTextFormat (const TextFormatParameters &parameters, string text)
	Updates the parameters and text of the internal text format.

	TextConceptImpl ()=default
	Constructor.

Properties
static PropertyType< float >	BaselineProperty
	Font baseline in 3D space units.

static PropertyType< bool >	TwoPassRenderingProperty
	Defines whether the Text Block 3D is rendered in two passes.

float	getBaseline () const
	Gets the value of the BaselineProperty property.

bool	isTwoPassRendering () const
	Gets the value of the TwoPassRenderingProperty property.

void	setTwoPassRendering (bool value)
	Sets the value of the TwoPassRenderingProperty property.

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

Static Protected Member Functions inherited from kanzi::Node
static VisitorResult	applyStylesVisitor (Node &node, bool apply)

static VisitorResult	attachVisitor (Node &node)

static VisitorResult	detachVisitor (Node &node)

static bool	processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason)
	Processes notification handlers for node and property storage.

static VisitorResult	propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason)

static VisitorResult	updateAllResourcesVisitor (Node &node)

static VisitorResult	updateResourceVisitor (Node &node, const ResourceID &id)

static VisitorResult	validateDrawVisitor (Node &node)
	Visitor for validating draw.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer	m_bindingRuntimes
	Bindings in this object.

Protected Attributes inherited from kanzi::TextConceptImpl< TDerivedClass >
TextFormatPtr	m_textFormat
	The text format for the text that this node displays.

Protected Attributes inherited from kanzi::RenderEntryRegistry< TextBlock3D >
flat_set< DrawObjectsRenderPassWeakPtr, owner_less< DrawObjectsRenderPassWeakPtr > >	m_referringRenderPasses
	Render passes referring to the Node deriving this template class.

Node3D::RenderEntryParameterContainer	m_renderEntryParameters
	Cached render entry parameters.

Detailed Description

Text Block 3D displays a small amount of text in 3D.

To render a Text Block 3D node Kanzi:

Prepares the text as 2D text using pixel metrics.
Projects the prepared text to 3D space using the value of Node::Projection2DTo3DScaleProperty to scale pixels to 3D units.

Use pixel values to set the values of text-specific properties such as the FontStyleConcept::SizeProperty or FontStyleConcept::FixedCharacterWidthProperty properties.

Use 3D units to adjust the layout of a Text Block 3D node in 3D space. For example, use 3D units to set the values of the Node::WidthProperty and Node::HeightProperty properties in a Text Block 3D node.

Text Block 3D does not support clipping.

See also: For a 2D text node, see TextBlock2D.

Examples

To create a Text Block 3D node:

// Create a Text Block 3D node named Text Block.

TextBlock3DSharedPtr textBlock = TextBlock3D::create(this->getDomain(), "Text Block");

To set the font family of a text block:

// Set the font family used by the Text Block node.

textBlock->setFontFamily(fontFamily);

To add the text shown by a text block:

// Set the text in the Text Block node to Hello world!.

textBlock->setText("Hello\nworld!");

To adjust the appearance of the text:

    // Set the style of the text in a Text Block 3D node:
    // Set the size of the font to 90 pixels.
    textBlock->setFontSize(90.0f);
    // Set the color of the font to blue.
    textBlock->setFontColor(ThemeBlue);
    // Set the width of the text block in 3D space to 4 3D units.
    textBlock->setWidth(4.0f);
    // Set the height of the text block in 3D space to 5 3D units.
    textBlock->setHeight(5.0f);
    // To break long text lines to multiple lines to make the text fit within
    // the boundaries of the text block, set the Word Wrap property to true.
    textBlock->setWordWrap(true);
    // Align the text in the text block to the right.
    textBlock->setTextHorizontalAlignment(TextFormat::TextHorizontalAlignmentRight);
    // Enable hinting. Prefer native hinter of the font over the auto-hinter of the rasterizer.
    textBlock->setHintingPreference(FontHintingPreference::NativeHinting);

To adjust the scaling factor of the 2D to 3D projection:

    // To scale the final text in 3D space, set the 2D to 3D projection scaling factor to 0.04.
    // The default value of the Node::Projection2DTo3DScaleProperty property is 0.02f.
    textBlock->setProjection2DTo3DScale(0.04f);

Member Typedef Documentation

◆ ConceptClass

typedef TextBlockConceptImpl<Node3D, TextBlock3D> kanzi::TextBlock3D::ConceptClass

Constructor & Destructor Documentation

◆ ~TextBlock3D()

kanzi::TextBlock3D::~TextBlock3D ( )

override

Destructor.

◆ TextBlock3D()

kanzi::TextBlock3D::TextBlock3D	(	Domain *	domain,
		string_view	name )

explicitprotected

Constructor.

Parameters

domain	The UI domain the new node belongs to.
name	The name of the node.

Member Function Documentation

◆ getBaseline()

float kanzi::TextBlock3D::getBaseline ( ) const

inline

Gets the value of the BaselineProperty property.

◆ isTwoPassRendering()

bool kanzi::TextBlock3D::isTwoPassRendering ( ) const

inline

Gets the value of the TwoPassRenderingProperty property.

See also: setTwoPassRendering()

◆ setTwoPassRendering()

void kanzi::TextBlock3D::setTwoPassRendering ( bool value )

inline

Sets the value of the TwoPassRenderingProperty property.

See also: isTwoPassRendering()

◆ create()

static TextBlock3DSharedPtr kanzi::TextBlock3D::create	(	Domain *	domain,
		string_view	name )

static

Creates a TextBlock3D node.

Parameters

domain	The UI domain the new node belongs to.
name	The name of the node.

Returns: The created node.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::TextBlock3D::makeEditorInfo ( )

static

◆ restoreResources()

void kanzi::TextBlock3D::restoreResources ( )

overridevirtual

Node::restoreResources() implementation.

Reimplemented from kanzi::Node.

◆ getGlyphTexture()

TextureSharedPtr kanzi::TextBlock3D::getGlyphTexture ( ) const

Access glyph texture.

Returns: Glyph texture.

◆ initialize()

void kanzi::TextBlock3D::initialize ( )

protected

Do TextBlock3D-specific initialization.

◆ prepareTextFormatForRendering()

bool kanzi::TextBlock3D::prepareTextFormatForRendering ( )

protected

Prepare text format for rendering.

Returns: True if text format was successfully prepared for rendering.

◆ updateRenderEntryParameters()

void kanzi::TextBlock3D::updateRenderEntryParameters ( )

protected

Update the internal storage of render entry parameters.

This function is ran every time rendering parameters change.

◆ onNodePropertyChanged()

void kanzi::TextBlock3D::onNodePropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason )

overrideprotectedvirtual

Node::onNodePropertyChanged() implementation.

Reimplemented from kanzi::Node3D.

◆ onDetached()

void kanzi::TextBlock3D::onDetached ( )

overrideprotectedvirtual

Node3D::onDetached() implementation.

Reimplemented from kanzi::Node3D.

◆ measureOverride()

Vector3 kanzi::TextBlock3D::measureOverride ( Vector3 availableSize )

overrideprotectedvirtual

Node3D::measureOverride() implementation.

Reimplemented from kanzi::Node3D.

◆ arrangeOverride()

void kanzi::TextBlock3D::arrangeOverride ( Vector3 actualSize )

overrideprotectedvirtual

Node3D::arrangeOverride() implementation.

Reimplemented from kanzi::Node3D.

◆ getBoundingBox()

optional< Box > kanzi::TextBlock3D::getBoundingBox ( ) const

overrideprotectedvirtual

Node3D::getBoundingBox() implementation.

Reimplemented from kanzi::Node3D.

◆ generateRenderStatesOverride()

const RenderEntryParameterContainer * kanzi::TextBlock3D::generateRenderStatesOverride ( DrawObjectsRenderPass & drawPass )

overrideprotectedvirtual

Node3D::generateRenderStatesOverride() implementation.

Reimplemented from kanzi::Node3D.

◆ registerDrawPassOverride()

void kanzi::TextBlock3D::registerDrawPassOverride ( DrawObjectsRenderPassSharedPtr drawPass )

overrideprotectedvirtual

Node3D::registerDrawPassOverride() implementation.

Reimplemented from kanzi::Node3D.

◆ renderOverride()

void kanzi::TextBlock3D::renderOverride	(	Renderer3D &	renderer,
		RenderEntry3D &	renderState )

overrideprotectedvirtual

Node3D::renderOverride() implementation.

Reimplemented from kanzi::Node3D.

Member Data Documentation

◆ DefaultTextLayoutDepth

const float kanzi::TextBlock3D::DefaultTextLayoutDepth

static

The size of the text block in Z-direction.

Used when constructing the text bounding box. By default, this value is insignificant as compared to normal layout sizes.

◆ BaselineProperty

PropertyType<float> kanzi::TextBlock3D::BaselineProperty

static

Font baseline in 3D space units.

The default value is 0.0f.

See also: getBaseline()

◆ TwoPassRenderingProperty

PropertyType<bool> kanzi::TextBlock3D::TwoPassRenderingProperty

static

Defines whether the Text Block 3D is rendered in two passes.

Disabling two-pass rendering improves performance, but can cause an invalid rendering result when glyph bounds overlap. The default value is true.

See also: setTwoPassRendering(), isTwoPassRendering()

The documentation for this class was generated from the following file:

kanzi/ui/node/text_block3d.hpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Examples

Member Typedef Documentation

◆ ConceptClass

Constructor & Destructor Documentation

◆ ~TextBlock3D()

◆ TextBlock3D()

Member Function Documentation

◆ getBaseline()

◆ isTwoPassRendering()

◆ setTwoPassRendering()

◆ create()

◆ makeEditorInfo()

◆ restoreResources()

◆ getGlyphTexture()

◆ initialize()

◆ prepareTextFormatForRendering()

◆ updateRenderEntryParameters()

◆ onNodePropertyChanged()

◆ onDetached()

◆ measureOverride()

◆ arrangeOverride()

◆ getBoundingBox()

◆ generateRenderStatesOverride()

◆ registerDrawPassOverride()

◆ renderOverride()

Member Data Documentation

◆ DefaultTextLayoutDepth

◆ BaselineProperty

◆ TwoPassRenderingProperty